docs: make README public-facing for CN and BytePlus - #15
Merged
Conversation
## Summary - rewrite the README for public SDK users - document Volcengine China and BytePlus client initialization - organize supported examples under examples/cn and examples/byteplus - use regional Chat, Responses, embedding, image, and video model IDs - remove retired Seededit image-edit examples - omit BytePlus text-only embedding examples, including batch variants, because BytePlus has no model for that endpoint - correct BytePlus IAM comments and environment variable names - keep MCP in both clouds and other hosted built-in tools CN-only with explicit beta headers - add usage and manual migration guidance without internal roadmap language ## Regional model defaults - Responses and Chat: doubao-seed-2-1-pro-260628 / seed-2-0-lite-260428 - Multimodal and sparse embeddings: doubao-embedding-vision-251215 / skylark-embedding-vision-251215 - Image: doubao-seedream-5-0-pro-260628 / dola-seedream-5-0-pro-260628 - Video: doubao-seedance-2-0-fast-260128 / dreamina-seedance-2-0-fast-260128 ## Validation - Python compileall across all regional examples after rebasing onto the latest generated SDK branch - verified no BytePlus text-only embedding call remains - documentation model, link, and whitespace checks See merge request: !81 Sync-Source-Commit: de8e67c2cb82d4cf53f484ce45a65349304479a4 Hand-Written-Reason: Hand-written public documentation and regional examples update; not produced by ark-apis generation. Release-Version: 0.4.0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hand-written change from the internal SDK repository — not produced by
make vendor.docs: make README public-facing for CN and BytePlusSync-Source-Commit: de8e67c2cb82d4cf53f484ce45a65349304479a4
Hand-Written-Reason: Hand-written public documentation and regional examples update; not produced by ark-apis generation.
Release-Version: 0.4.0
Created by ark-hand.